Modify Subscriber Offer

This API is used to modify the attributes of an existing subscriber plan.

HTTP URL
PATCH	/api/v2/subscriber/{type}/{value}/offer/{id}

NOTE: All {type} and {value} pairs, define the search criteria. Valid {type} ENUMs are: ‘imsi’, ‘iccid’, ‘msisdn’, ‘imei’.

Eligibility

The Requester is eligible to modify a Regular plan of sub-customers’ subscribers or a Pool plan attached to sub-customers.

The Requester is not allowed to modify a plan of own subscribers.

API Request

Request Structure

Parameter	Type	M/O/CM	Description
priority	Numeric	O	Plan order of priority; the higher the numeric value, the higher priority the plan receives. For example, a plan with priority 100 precedes plan with priority 50. The Rater does not enforce the sequential order of any plan’s priorities and so it has no meaning. Note: The Rater does not enforce the uniqueness of an assigned priority between a subscriber’s plans. Therefore, prevent sending an existing plan’s priority value to this plan.
expirationDate	Date	O	Determines the requested date as per the selected expirationType set when plan created. Can be used only if the expirationType parameter has been set to FIXED. Rejected for other expirationType settings.

API Response

Response Structure

Parameter	Type	M/O/CM	Description
errorCode	String	O	Failure code.
errorMessage	String	O	Failure message.
content	Object	O	Array of main response body object displayed when an API call was successful. For a failure, it will be empty.
pageable	Object	O	Paging information object displayed when an API call was successful. For a failure, it will be empty.

Content data objects

Element	Type	M/O/CM	Description
requestId	UUID	M	Request instance ID. To be used by external systems to query the call (operation) status: In progress Successful Failed.

Pageable data objects

Element	Type	M/O/CM	Description
page	Numeric	M	Page number
size	Numeric	M	Page size. Number of requested elements per page
totalPages	Numeric	M	Total amount of available pages per requested page size
totalElements	Numeric	M	Total amount of retrieved elements

Error Codes

In addition to the general success and failure codes, the following error codes are possible.

Code	Message
GLOBAL_1001	Service unavailable. Please try again
SUBSCRIBER_1026	Failed to modify offer

Examples

Request Body

Response Body: Success ACK

Response Body: Failure NAK